feat: Create admin protected endpoint for creating users #981

dcoric · 2025-04-15T12:47:31Z

Introduce a new API endpoint for creating users and a corresponding command in the git-proxy-cli to interact with this endpoint. The new functionality enables administrators to create new user accounts via the CLI.

Changes

Added a createUser function to packages/git-proxy-cli/index.js that handles user creation via an API call. It checks for authentication cookies and makes a POST request to the /api/auth/create-user endpoint.
Added a create-user command to the CLI using yargs in packages/git-proxy-cli/index.js. This command takes username, password, email, gitAccount, and an optional admin flag as arguments.
Created a new route /api/auth/create-user in src/service/routes/auth.js that handles the user creation request. It checks for admin privileges and validates the request body before creating the user in the database.
Added tests for the create-user command to packages/git-proxy-cli/test/testCli.test.js, covering scenarios such as server down, no authentication, missing required fields and successful user creation.
Added tests for the /api/auth/create-user route to test/testLogin.test.js to verify authentication, authorization, data validation, and successful user creation.

Impact

Introduces a new create-user command to the git-proxy-cli, enabling administrators to create user accounts directly from the command line.
The /api/auth/create-user endpoint is now available, allowing authenticated administrators to create new user accounts.
Depends on the axios library in packages/git-proxy-cli/index.js.
Relies on the database interaction functions in src/service/routes/auth.js to create user records.
The new feature requires the user to be authenticated as an admin to create new users.

Resolves #980

netlify · 2025-04-15T12:47:48Z

✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name	Link
🔨 Latest commit	`bfddc1c`
🔍 Latest deploy log	https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/6891e2f2c6a496000909051e

kriswest · 2025-04-15T17:46:50Z

You could replace or remove this test, which is currently skipped, with your new tests:

git-proxy/test/testUserCreation.test.js

Lines 42 to 50 in 3718943

	it('should be able to create a new user', async function () {
	const res = await chai.request(app).post('/api/auth/profile').set('Cookie', `${cookie}`).send({
	username: 'login-test-user',
	email: '[email protected]',
	gitAccount: 'test123',
	admin: true,
	});
	res.should.have.status(200);
	}).skip();

jescalada

The code looks good! I've had some problems executing the tests, although some issues were present before.

Let me know if I'm missing something! 🙂

packages/git-proxy-cli/index.js

packages/git-proxy-cli/test/testCli.test.js

jescalada · 2025-05-30T06:30:58Z

Also, it would be very helpful to execute the git-proxy-cli tests in the CI, so we don't accidentally introduce bugs...

JamieSlome · 2025-07-01T13:19:33Z

What's the status of this PR? @jescalada @dcoric

dcoric · 2025-07-01T14:02:21Z

What's the status of this PR? @jescalada @dcoric

I’m currently OOO but I plan to polish this up by the end of the week. I will ping here once it is ready for another review

codecov · 2025-07-14T12:35:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.64%. Comparing base (4956b73) to head (a4d3526).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #981      +/-   ##
==========================================
+ Coverage   77.40%   77.64%   +0.23%     
==========================================
  Files          55       55              
  Lines        2293     2304      +11     
  Branches      258      258              
==========================================
+ Hits         1775     1789      +14     
+ Misses        488      485       -3     
  Partials       30       30

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

dcoric · 2025-07-14T13:55:11Z

@JamieSlome @jescalada I've implemented all the requested changes. I ran into some challenges with the tests, but everything should be working correctly now. When you have a moment, could you please review the updates? It should be all set for merging.

Let me know if you spot anything else that needs adjustment - otherwise, it's good to go!

jescalada

Looks good so far 👍🏼 I spent some time finding fixes for the failing CLI tests. Hopefully committing those directly will fix things.

jescalada · 2025-08-05T12:22:55Z

packages/git-proxy-cli/test/testCli.test.js

@@ -483,6 +483,114 @@ describe('test git-proxy-cli', function () {
    });
  });

+  // *** create user ***
+
+  describe('test git-proxy-cli :: create-user', function () {


These functions fix one of the failing CLI tests:

Suggested change

describe('test git-proxy-cli :: create-user', function () {

describe('test git-proxy-cli :: create-user', function () {

before(async function () {

await helper.addRepoToDb(TEST_REPO_CONFIG);

await helper.addUserToDb('testuser', 'testpassword', '[email protected]', 'testGitAccount1');

});

after(async function () {

await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);

await helper.removeUserFromDb('newuser');

await helper.removeUserFromDb('testuser');

});

jescalada · 2025-08-05T12:24:18Z

packages/git-proxy-cli/test/testCli.test.js

+        await helper.runCli(`npx -- @finos/git-proxy-cli login --username admin --password admin`);
+
+        const cli = `npx -- @finos/git-proxy-cli create-user --username newuser --email [email protected] --gitAccount newgit`;
+        const expectedExitCode = 4;


Oddly, this fix didn't get applied previously (will fix the test):

Suggested change

const expectedExitCode = 4;

const expectedExitCode = 1;

const expectedMessages = null;

const expectedErrorMessages = ['Missing required argument: password];

jescalada · 2025-08-05T12:27:46Z

packages/git-proxy-cli/index.js

+  try {
+    const cookies = JSON.parse(fs.readFileSync(GIT_PROXY_COOKIE_FILE, 'utf8'));
+
+    const response = await axios.post(


Linter issue here:

351:11 error 'response' is assigned a value but never used no-unused-vars

dcoric mentioned this pull request Apr 15, 2025

[Feature]: Create admin protected endpoint for creating users G-Research/git-proxy#40

Open

dcoric changed the title ~~[Feature]: Create admin protected endpoint for creating users~~ [feat]: Create admin protected endpoint for creating users Apr 22, 2025

dcoric changed the title ~~[feat]: Create admin protected endpoint for creating users~~ feat: Create admin protected endpoint for creating users Apr 22, 2025

github-actions bot added the feature label Apr 22, 2025

dcoric force-pushed the denis-coric/create-user branch 2 times, most recently from d6f580d to 271916f Compare May 16, 2025 11:02

dcoric linked an issue May 16, 2025 that may be closed by this pull request

[Feature]: Create admin protected endpoint for creating users G-Research/git-proxy#40

Open

jescalada requested changes May 30, 2025

View reviewed changes

packages/git-proxy-cli/index.js Outdated Show resolved Hide resolved

packages/git-proxy-cli/test/testCli.test.js Show resolved Hide resolved

packages/git-proxy-cli/test/testCli.test.js Show resolved Hide resolved

dcoric force-pushed the denis-coric/create-user branch 2 times, most recently from 3f7a0be to a4d3526 Compare July 14, 2025 12:32

feat: adds create user endpoint and cli command

d4d9020

dcoric force-pushed the denis-coric/create-user branch from a4d3526 to d4d9020 Compare August 1, 2025 13:33

Merge branch 'main' into denis-coric/create-user

bfddc1c

jescalada requested changes Aug 5, 2025

View reviewed changes

jescalada reviewed Aug 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Create admin protected endpoint for creating users #981

feat: Create admin protected endpoint for creating users #981

dcoric commented Apr 15, 2025

Uh oh!

netlify bot commented Apr 15, 2025 •

edited

Loading

Uh oh!

kriswest commented Apr 15, 2025

Uh oh!

jescalada left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jescalada commented May 30, 2025

Uh oh!

JamieSlome commented Jul 1, 2025

Uh oh!

dcoric commented Jul 1, 2025

Uh oh!

codecov bot commented Jul 14, 2025

Uh oh!

dcoric commented Jul 14, 2025

Uh oh!

jescalada left a comment

Uh oh!

jescalada Aug 5, 2025

Uh oh!

jescalada Aug 5, 2025

Uh oh!

jescalada Aug 5, 2025

Uh oh!

Uh oh!

-  describe('test git-proxy-cli :: create-user', function () {
+  describe('test git-proxy-cli :: create-user', function () {
+    before(async function () {
+      await helper.addRepoToDb(TEST_REPO_CONFIG);
+      await helper.addUserToDb('testuser', 'testpassword', '[email protected]', 'testGitAccount1');
+    });
+    after(async function () {
+      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
+      await helper.removeUserFromDb('newuser');
+      await helper.removeUserFromDb('testuser');
+    });

-        const expectedExitCode = 4;
+        const expectedExitCode = 1;
+        const expectedMessages = null;
+        const expectedErrorMessages = ['Missing required argument: password];

feat: Create admin protected endpoint for creating users #981

Are you sure you want to change the base?

feat: Create admin protected endpoint for creating users #981

Conversation

dcoric commented Apr 15, 2025

Changes

Impact

Uh oh!

netlify bot commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Uh oh!

kriswest commented Apr 15, 2025

Uh oh!

jescalada left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jescalada commented May 30, 2025

Uh oh!

JamieSlome commented Jul 1, 2025

Uh oh!

dcoric commented Jul 1, 2025

Uh oh!

codecov bot commented Jul 14, 2025

Codecov Report

Uh oh!

dcoric commented Jul 14, 2025

Uh oh!

jescalada left a comment

Choose a reason for hiding this comment

Uh oh!

jescalada Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

jescalada Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

jescalada Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify bot commented Apr 15, 2025 •

edited

Loading